home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / pcdone / pcdone.doc < prev   
Encoding:
Text File  |  1994-08-11  |  5.6 KB  |  157 lines
  1. * Pcdone.DLL (C) 1994, Paul Lee / Abri Technologies, Inc.
  2.  
  3. If this is your demo version of PCdone, please see the licence.doc file
  4. for further information.
  5.  
  6. LEGAL STUFF:
  7.   Author disclaims any liabilities for use of PCdone or fitness or
  8.   suitability for any purpose.
  9.  
  10.   Author contact info is at end of this doc.
  11.  
  12. PURPOSE:
  13.   The pcdone() function displays a percentage progress bar window while
  14.   a task is working.
  15.   
  16.   Often, a client has to sit and wait for a longer task to finish while 
  17.   nothing is happening on screen and may wonder whether the computer has 
  18.   locked up. You have frequently seen the % progress bars on software 
  19.   installation programs and other places.
  20.  
  21.   Here is a handy, universal, easy-to-use program which you can include in 
  22.   your VisualBasic and other windows applications if they can access DLL's. 
  23.   You can use it during long printing procedures, large calculations, 
  24.   scanning through long databases, SQL's. etc.
  25.  
  26. HOW TO USE IT IN VisualBasic:
  27.   Copy pcdone.dll file to the working directory of your program.
  28.   
  29.   In a module or form declaration section include the following statement 
  30.   all in one line.
  31.  
  32.   Declare Function PCdone Lib "pcdone.dll" (ByVal hWnd As Integer, 
  33.               ByVal Percent As Integer, ByVal Title As String) As Integer
  34.   
  35.   Then afterwards you can simply use it with the statement
  36.   
  37.   SomeIntVar = PCdone(Form.hWnd, Percent, YourMessageHere)
  38.   
  39.   Where: SomeIntVar is an integer variable,
  40.          Percent is the percentage bar length you want to display, and
  41.          YourMessageHere is a string of characters that you want to
  42.              display on top of the percentage bar.
  43.  
  44.   Example: kkk = PCdone(Form2.hWnd, 34, "Working Please Wait......")
  45.  
  46.   To end the PCdone window use it with Percent value greater than 100.
  47.  
  48.   IMPORTANT NOTE: Make sure you select the topmost visible/existing form 
  49.   for the Form.Hwnd argument. Otherwise the PCdone window may actually be 
  50.   hiding behind the form or not initialize properly. PCdone does not have
  51.   to be called from the topmost form, only related to it in "Form.hWnd".
  52.   
  53.                 Example VisualBasic Program Syntax:
  54.                 ===================================
  55.  
  56.      ' MODULE1 declaration section
  57.      Declare Function PCdone Lib "pcdone.dll" (ByVal hWnd As Integer, 
  58.            ByVal Percent As Integer, ByVal Title As String) As Integer
  59.    
  60.  
  61.      ' Form1 
  62.      Sub IDOK_click()
  63.        Dim Msg As String, kk As Integer, i as integer, Imax as integer    
  64.        Msg = "Working. Please wait......"
  65.        kk = Pcdone(Form1.hWnd, 0, Msg)      'initial 0 display at beginning.
  66.            .
  67.            .
  68.        kk = Pcdone(Form1.hWnd, 5, Msg)      'a bit further on 
  69.            .
  70.            .
  71.        For i = 1 TO Imax
  72.          kk = Pcdone(Form1.hWnd, (5 + i/Imax*85), Msg)   'est. 85% for loop.
  73.              .
  74.              .
  75.              .
  76.        Next
  77.              .
  78.        kk = Pcdone(Form1.hWnd, 95, "We're almost there...")
  79.            .
  80.        kk = Pcdone(Form1.hWnd, 100, "Done")
  81.        kk = Pcdone(Form1.hWnd, 200, "")    'to remove the Pcdone window
  82.      End Sub
  83.  
  84. PCdone IN SQL and DATABASE:
  85.   It is possible to use pcdone in VisalBasic SQL Select string using
  86.   the WHERE clause. Here is a simple example:
  87.  
  88.   "Select Name, Picture from Authors where 
  89.           PCdone(Form1.hWnd, (5 + i/Imax*85), Msg) > 0 "
  90.    
  91.    A more extensive DATABASE and SQL example discussion is available
  92.    in file PCdone.zip in CompuServe FoxForum Library 3.
  93.  
  94. HOW TO USE IT IN Windows C/C++:
  95.   The simplest way to use the PCdone.DLL program is to add its name to
  96.   the IMPORTS section of the .DEF file as
  97.   
  98.   .
  99.   .
  100.   IMPORTS PCDONE.PCdone
  101.   .
  102.   .
  103.   
  104.   Alternatively you can use the LoadLibrary(), GetProcAddress() and
  105.   FreeLibrary() functions to use PCdone.DLL.
  106.   
  107.   The function C syntax is:
  108.   int FAR PASCAL PCdone(HWND hWnd, int Percent, LPSTR Title);
  109.   
  110. RESERVED PCDONE VALUES AND ARGUMENTS:
  111.   Special Percent values:
  112.      Value   Function
  113.      > 100   Erase PCdone window and unload it from memory.
  114.      -7654   Display licencing information.
  115.  
  116.   Return values of PCdone function: 
  117.   (value of SomeIntVar)
  118.      Value    Meaning
  119.       0       A system error occured in loading the PCdone window.
  120.       1       PCdone window has been initialized successfully.
  121.       2       A regular progress-bar/title update was processed.
  122.       3       PCdone window has been erased and unloaded from memory.
  123.       4       Licencing information has been requested/processed.
  124.  
  125.   Other:
  126.   Eratic progress bar activity - disappearance, etc. It means that your 
  127.   percentages are not increasing steadily but going random.
  128.  
  129. OPTIMIZING for SPEED:
  130.   PCdone displays progress for integer values of Percent only.
  131.   If a new call to it has the same percent value as the previous value,
  132.   PCdone returns without updating its window and thus saves some
  133.   CPU time.
  134.  
  135. --------------------------------------------------------------------------
  136. AUTHOR INFORMATION:
  137. The author is available for VisualBasic/FoxproW/C(DOS/Win)/Pascal/...
  138. programming/consulting.
  139.  
  140. Professional, well documented software development. Large or small jobs 
  141. considered, $25-35/hr, satisfaction guarantee.
  142.  
  143. CAUTION: The author is over 50, not sexy, charming or verbally impressive - 
  144. but does good quality, honest work.
  145.  
  146. You can contact him 
  147.  
  148. by mail:         Paul Lee
  149.                  Abri Technologies, Inc.
  150.                  HC 62, Box 100K
  151.                  Great Cacapon, WV 25422 USA
  152.  
  153. by E-Mail:       72345.1623@compuserve.com
  154.  
  155. by phone:        (304) 947-7129
  156.  
  157.